home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Best of www.BestZips.com (Collector's Edition)
/
Best of WWW.BESTZIPS.COM Collector's Edition (JCSM Shareware) (JCS Marketing).ISO
/
help_sys
/
hlpgn131.zip
/
hlpgen.mac
< prev
next >
Wrap
Text File
|
1996-09-05
|
26KB
|
684 lines
.rem(====================================)
.rem(| Macro File for HelpGen Help |)
.rem(|Copyright 1994-95 Rimrock Software|)
.rem(| All rights reserved. |)
.rem(====================================)
.startc(main,Contents,HLPGEN.BMP,HelpGen Help,general,001)
.top(Help)
.top(Table of Contents)
.n
.b(Purpose) - Click on icon above.n.n
.b(How to).n
.in
##.j(lodmac,Load or Create a Macro file)
##.j(crehpj,Load or Create a Project File)
##.j(bldall,Build a Help File from a MAC File)
##.j(bldhtml,Build an HTML File from a MAC File)
##.j(lang,The HelpGen Macro Language)
.un
.n
.j(mnucmd,Menu Commands).n
.n
.bmacro(Search,search.bmp)\tab.b(Search for Topic).n
.n
.bj(glossary,demo.bmp)\tab.b(Glossary).n
.n
If you are unfamiliar with how Windows Help works, choose
.b(Help | How To Use Help) from the Help menu now.
.end
.com(=================================)
.com( Icon topic )
.com(=================================)
.ent(icon,Information,HelpGen ) \qc
HelpGen version 1.30. \'a9 1994-95 by Rimrock Software, all rights
reserved..n.n \ql
Under normal circumstances, if you want to create a help file with
the Windows help compiler, you must first create a help topic file
using a word processor that can save files in Rich Text Format
(.p1(RTF)). There are several basic problems with that approach:.n
.in
#n(1)Word processors cost a lot of money..n
#n(2)Once you've purchased the word processor, you have to
learn how to use it. This may not be a very productive use of
your programming time..n
#n(3)You also have to learn how to use the word processor to
produce a file that is properly formatted for the help compiler.
This involves using items like underlining, double-underlining,
hidden text, footnotes, etc..n
.un
HelpGen eliminates these problems by allowing you to use your
favorite ASCII text editor to produce a HelpGen .p1(macro) file,
which HelpGen uses to create the RTF formatted file required by
the help compiler..n.n
HelpGen automates the entire process of creating help files:.n
.in
##Creates a skeleton macro file for you to edit.
##Invokes your editor to allow you to edit the macro file.
##Creates a help project file (.HPJ) to tell the help
compiler how to compile the help file.
##Generates an RTF file from the macro file.
##Invokes the help compiler to compile the RTF file into a
HLP file.
##Allows you to directly test the result..n
.n
.box
The HelpGen macro engine is based on code written by David Spector,
and published in Windows/DOS Developer's Journal, Vol. 5, No. 7,
July 1994.
.bend
.n
.rem(This version of HelpGen is a .p1(shareware) evaluation version. You)
.rem( may use this version for up to 60 days to determine whether the)
.rem( program is of use to you. If you continue to use the program)
.rem( beyond that time period\'2c you must register. Registration of)
.rem( HelpGen is $30.)
.end
.com(=================================)
.com( Load/Create macros topic )
.com(=================================)
.entc(lodmac,Load/Create Macro File,How to ,general,010)
Select the .b(File | Open Macro File) menu option. Select an
existing .MAC file or enter the name of a new file. If you enter
the name of a file that does not exist, HelpGen will create the
file for you, using a .p1(template) that contains the minimum items
required to build a help file..n
.n
If you have created a new .p1(macro) file, you should use the
.b(Edit | Macro File) option to make two changes to the file. The
first change is a new title for the table of contents. The default
title is xxxx. The second change is the selection of a .BMP
graphic to place on the table of contents title line. The default
is HlpGen.BMP.
.end
.com(=================================)
.com( Load/Create project file topic )
.com(=================================)
.entc(crehpj,Load/Create Project File,How to ,general,020)
HelpGen looks for an associated .p1(project) file when you open the
current macro file. If it finds one, HelpGen will enable the
.b(Edit | Project File) menu item, and you won't have to build a
project file. If it doesn't find a project file, HelpGen will
enable the .b(Build | Project File) menu item to allow you to
create a project file. You must select .b(Build | Project File) to
create the new project file..n
.n
.box
.b(NOTE:) Before you build a project file, select the
.b(Options | Project File) menu item and make sure that all the
items in that dialog are to your liking. Those items will be used
to create the project file.
.bend
.end
.com(=================================)
.com( how to build HLP from MAC )
.com(=================================)
.entc(bldall,Build a HLP File From a MAC File,How to ,general,043)
Select the .b(Build | HLP form MAC) menu item. HelpGen will create
a .RTF file by processing the .MAC file.
Macros will be expanded and .p(rtfcmds,RTF commands) and plain text
will be passed through to the .RTF file..n.n HelpGen then will invoke
the .p(hlpcmplr,help compiler) you have selected
in the .b(Options | Directories) menu item. This will involve
shelling out to DOS, since help compilers are DOS programs. When
HelpGen gets control again, it will enable the .b(Test) menu item,
to allow you to test the help file you have just created..n
.n
If there were errors generated during the help compilation, they
will be listed in the error log file that is shown in
.b(Options | Project File)..n
.n
.box
.b(NOTE:) When HelpGen invokes the help compiler, and for some
reason the compiler can't execute, HelpGen will notify you by
displaying an error message. To possibly correct your problem,
make sure that the proper help compiler is correctly chosen in
HelpGen's .b(Options | Directories) menu item.
.bend
.end
.com(=================================)
.com( how to build HTML from MAC )
.com(=================================)
.entc(bldhtml,Build an HTML File From a MAC File,How to ,general,046)
Select the .b(Build | HTML File) menu item. HelpGen will create a World
Wide Web .p1(HTML) page from the current .MAC file. The generated file will have
a .HTM file extension. You can test this file by selecting the
.b(Test | Test HTML File) menu item.
.end
.com(=================================)
.com( using helpgen TOC topic )
.com(=================================)
.entc(lang,Macro Language,The HelpGen ,general,050)
.in
##.j(langbas,Macro Language Basics)
##.j(maccmd,Macro Language Commands)
##.j(rtfcmd,Useful RTF Commands)
.un
.end
.com(=================================)
.com( menu topic )
.com(=================================)
.entc(mnucmd,HelpGen Menu,The ,general,055)
.in
.bmp(mnu.shg).n
.n
Click on the menu item you want help with.
.un
.end
.com(=================================)
.com( file commands topic )
.com(=================================)
.entc(file,File Commands,The ,general,060)
.in
.bmp(mnufil.shg).n
.n
Click on the menu item you want help with.
.un
.end
.com(=================================)
.com( edit commands TOC topic )
.com(=================================)
.entc(edit,Edit Commands,The ,general,070)
.in
.bmp(mnuedt.shg).n
.n
Click on the menu item you want help with.
.un
.end
.com(=================================)
.com( build commands TOC topic )
.com(=================================)
.entc(generate,Build Commands,The ,general,080)
.in
.bmp(mnubld.shg).n
.n
Click on the menu item you want help with.
.un
.end
.com(=================================)
.com( test command topic )
.com(=================================)
.entc(testem,Test Command,The ,general,090)
.in
.bmp(mnutst.shg).n
.n
Click on the menu item you want help with.
.un
.end
.com(=================================)
.com( options commands TOC topic )
.com(=================================)
.entc(options,Options Commands,The ,general,100)
.in
.bmp(mnuopt.shg).n
.n
Click on the menu item you want help with.
.un
.end
.com(=================================)
.com( help commands TOC topic )
.com(=================================)
.entc(help,Help Commands,The ,general,110)
.in
.bmp(mnuhlp.shg).n
.n
Click on the menu item you want help with.
.un
.end
.com(=================================)
.com( open macro file topic )
.com(=================================)
.entc(open,Open Macro File, ,general,120)
Open an existing .p1(macro) file, or create a new macro file to be
edited (.b(File | Open Macro File) menu item). A check will be made
for a corresponding .p1(project) file. If a project file exists,
then the .b(Edit | Project File) menu item will be enabled. If a
project file does not exist, then the .b(Build | Project File) menu
item will be enabled. The HelpGen .p(titlebar,title bar) is
updated to reflect the current macro file name.
.s
.bmpl(openrtf.bmp)You may also select this menu item with the
.p1(toolbar) Open Macro File button.
.end
.com(=================================)
.com( close macro file topic )
.com(=================================)
.entc(close,Close Macro File, ,general,130)
The Close command closes all files and disables all HelpGen menu
items that are associated with open files
(.b(File | Close Macro File) menu item). The HelpGen
.p(titlebar,title bar) is updated to show that no .p1(macro) file
is currently open.
.s
.bmpl(closertf.bmp)You may also select this menu item with the
.p1(toolbar) Close Macro File button.
.end
.com(=================================)
.com( print macro file topic )
.com(=================================)
.entc(print,Print Macro File, ,general,140)
The Print command will print the current .p1(macro) file on any
printer (.b(File | Print Macro File) menu item). You will be asked
to select the proper printer before any printing takes place.
.s
.bmpl(printrtf.bmp)You may also select this menu item with the
.p1(toolbar) Print Macro File button.
.end
.com(=================================)
.com( exit topic )
.com(=================================)
.entc(exit,Exit to Program Manager, ,general,150)
The Exit command closes all open files and shuts down the HelpGen
program (.b(File | Exit) menu item).
.end
.com(=================================)
.com( edit macro file topic )
.com(=================================)
.entc(editmac,Edit Macro File, ,general,160)
The .b(Edit | Macro File) command executes a text editor and allows
you to make changes to the current .p1(macro) file. The default
text editor is NOTEPAD.EXE. The default editor may be changed using
the .b(Options | Directories) menu item.
.s
.bmpl(edmacrtf.bmp)You may also select this menu item with the
.p1(toolbar) Edit Macro File button.
.s
.box
.b(NOTE:) When HelpGen invokes the text editor, and for some reason
the editor can't be executed, HelpGen will notify you by displaying
an error message. To possibly correct your problem, make sure that
the text editor is correctly chosen in HelpGen's
.b(Options | Directories) menu item.
.bend
.end
.com(=================================)
.com( edit project file topic )
.com(=================================)
.entc(edithpj,Edit Project File, ,general,170)
The .b(Edit | Project File) menu item executes a text editor and
allows you to make changes to the current .p1(project) file. The
default text editor is NOTEPAD.EXE. The default editor may be
changed using the .b(Options | Directories) menu item.
.s
.bmpl(edhpjrtf.bmp)You may also select this menu item with the
.p1(toolbar) Edit Project File button.
.s
.box
.b(NOTE:) When HelpGen invokes the text editor, and for some reason
the editor can't execute, HelpGen will notify you by displaying an
error message. To possibly correct your problem, make sure that
the text editor is correctly chosen in HelpGen's
.b(Options | Directories) menu item.
.bend
.end
.com(=================================)
.com( edit bitmap file topic )
.com(=================================)
.entc(editbit,Edit Bitmap, ,general,180)
The .b(Edit | Bitmap) menu item executes a paint program and allows
you to make changes to a bitmap. The default paint program is
PBRUSH.EXE. The default program may be changed using the
.b(Options | Directories) menu item.
.s
.box
.b(NOTE:) When HelpGen invokes the paint program, and for some reason
the program can't execute, HelpGen will notify you by displaying an
error message. To possibly correct your problem, make sure that
the paint program is correctly chosen in HelpGen's
.b(Options | Directories) menu item.
.bend
.end
.com(=================================)
.com( edit hotspot file topic )
.com(=================================)
.entc(edithot,Edit Hotspot, ,general,190)
The .b(Edit | Hotspot) menu item executes the Microsoft hotspot
editor and allows you to mark hotspots on a bitmap. The
default hotspot editor is SHED.EXE. The default editor may be
changed using the .b(Options | Directories) menu item.
.s
.box
.b(NOTE:) When HelpGen invokes the hotspot editor, and for some reason
the editor can't execute, HelpGen will notify you by displaying an
error message. To possibly correct your problem, make sure that
the text editor is correctly chosen in HelpGen's
.b(Options | Directories) menu item.
.bend
.end
.com(=================================)
.com( build project file topic )
.com(=================================)
.entc(genhpj,Build Project File, ,general,200)
If you don't yet have a .p1(project) file for your current
.p1(macro) file, this menu item will be enabled
(.b(Build | Project File) menu item). It will create a project file
for you, based on the entries contained in the .b(Options) menu.
You may then make any changes to this file using the
.b(Edit | Project File) menu item. The project file will have the
same filename as the macro file, with an extension of .HPJ.
.s
.bmpl(buhpjrtf.bmp)You may also select this menu item with the
.p1(toolbar) Build Project File button.
.end
.com(=================================)
.com( build RTF file topic )
.com(=================================)
.entc(genrtf,Build RTF File Only, ,general,210)
The .b(Build | RTF File Only) menu item uses the current .p1(macro) file
to build a Rich Text Format (.p1(RTF)) file of the same name. The
RTF file is used as an input file for the .p(hlpcmplr,help compiler)..n
.end
.com(=================================)
.com( build HLP file topic )
.com(=================================)
.entc(genhlp,Build HLP File Only, ,general,220)
The .b(Build | HLP File) menu item uses the current .p1(project)
file and the .p1(RTF) file created by HelpGen to create a Microsoft
Help File (HLP). It does this by invoking the Microsoft (or other)
help compiler. The default help compiler is HC31.EXE. You may
change the default help compiler by using the
.b(Options | Directories) menu item.
.s
.box
.b(NOTE:) When HelpGen invokes the help compiler, and for some
reason the compiler can't execute, HelpGen will notify you by
displaying an error message. To possibly correct your problem, make
sure that the proper help compiler is correctly chosen in HelpGen's
.b(Options | Directories) menu item.
.bend
.end
.com(=================================)
.com( build HLP from MAC topic )
.com(=================================)
.entc(genmachlp,Build HLP from MAC, ,general,225)
The .b(Build | HLP from MAC) menu item uses .p1(macro) file to create
an .p1(RTF) file. It then uses the current .p1(project)
file and the .p1(RTF) file to create a Microsoft
Help File (HLP). It does this by invoking the Microsoft (or other)
help compiler. The default help compiler is HC31.EXE. You may
change the default help compiler by using the
.b(Options | Directories) menu item.
.s
.bmpl(buhlprtf.bmp)You may also select this menu item with the
.p1(toolbar) Build HLP from MAC button.
.s
.box
.b(NOTE:) When HelpGen invokes the help compiler, and for some
reason the compiler can't execute, HelpGen will notify you by
displaying an error message. To possibly correct your problem, make
sure that the proper help compiler is correctly chosen in HelpGen's
.b(Options | Directories) menu item.
.bend
.end
.com(=================================)
.com( build HTML file topic )
.com(=================================)
.entc(genhtml,Build HTML File, ,general,227)
The .b(Build | HTML File) menu item uses the current
.p1(RTF) file created by HelpGen to create a World
Wide Web hypertext markup language (.p1(HTML)) file. The
created file has a .HTM file extension.
.end
.com(=================================)
.com( test command topic )
.com(=================================)
.entc(testhlp,Test HLP file, ,general,228)
The .b(Test HLP file) menu item allows you to test the
help file that you have just generated. It will
only be enabled after you have generated a help file.
.s
.bmpl(testrtf.bmp)You may also select this menu item with the
.p1(toolbar) Test Help File button.
.end
.com(=================================)
.com( test command topic )
.com(=================================)
.entc(testhtml,Test HTML file, ,general,228)
The .b(Test HTML file) menu item allows you to test the
hypertext markup language file that you have just generated.
It does this by invoking the Web browser you have designated
in the .b(Options | Directories) dialog.
.end
.com(=================================)
.com( directories options topic )
.com(=================================)
.entc(optdir,Directories,Set ,general,230)
The .b(Options | Directories) menu item allows you to select the
.p(hlpcmplr,help compiler) and text editor that HelpGen uses when
building a help file or editing text. You can also select a Paint
program, a Hotspot Editor and a Web browser for HelpGen to use.
The entries that you make are saved in HelpGen's .INI file and
will be used each time you execute HelpGen.
.end
.com(=================================)
.com( project file options topic )
.com(=================================)
.entc(opthpj,Project File Options,Set ,general,240)
The .b(Options | Project File) menu item allows you to specify the
options that will be installed in a .p1(project) file that is
created by HelpGen. Some of these options are saved in HelpGen's
.INI file, so they may be used in subsequent executions of HelpGen.
Specifically, the Compression type, Warnings, Report status,
Copyright notice and Error Log are all saved in the .INI file..n
.n
.i(Title).n
The Title specifies the string that is placed on the Help File's
.p(titlebar,title bar) when the help file is executed..n
.n
.i(Copyright).n
The Copyright specifies the string that is placed inside of the help
file's About box. This box is activated by executing the help file
and selecting .b(Help | About Help)..n
.n
.i(Error Log).n
The Error Log is the file that the .p(hlpcmplr,help compiler) uses
to write error messages to. If you have errors during a help
compilation, look at this file to see what the errors were..n
.n
.i(Icon File).n
The Icon File entry specifies the icon that will be used when the
help file is minimized. This entry will override the default
question mark icon..n
.n
.i(Bitmap Root).n
The Bitmap Root specifies the directory that is used to store bitmap
files, if they are not in the current directory..n
.n
.i(Compression).n
The Compression option specifies what type of compression is used
when building the help file. .b(0) specifies no compression,
.b(Medium) specifies 40% compression and .b(High) specifies 50%
compression..n
.n
.i(Warnings).n
The Warnings option sets the level of error messages that the help
compiler will display during compilation. .b(Some) means only the
most severe messages will be displayed, .b(Many) means a medium
amount of error messages will be displayed, and .(All) means display
all messages..n
.n
.i(Report).n
The Report option determines the type of error messages that are
displayed during help file compilation.
.end
.com(=================================)
.com( help contents topic )
.com(=================================)
.entc(hlpcon,Help Contents, ,general,250)
The .b(Help | Contents) menu item executes the help file you are
currently reading.
.s
.bmpl(helprtf.bmp)You may also select this menu item with the
.p1(toolbar) Help Contents button.
.end
.com(=================================)
.com( help using topic )
.com(=================================)
.entc(hlpsrch,Search for Help on, ,general,251)
The .b(Help | Search for Help on) menu item invokes the
standard Search dialog for the HelpGen Help file.
.end
.com(=================================)
.com( help using topic )
.com(=================================)
.entc(hlpusing,Help on Help, ,general,252)
The .b(Help | Help on Help) menu item executes a
standard help file that explains how to use Help files.
.end
.com(=================================)
.com( register helpgen topic )
.com(=================================)
.entc(register,Register HelpGen, ,general,260)
The .b(Help | Register HelpGen) menu item allows you to fill out
entries and print a registration form. The entries will be printed
one line after the other. If any entry is missing, that entry will
not be printed.
.end
.com(=================================)
.com( about helpgen topic )
.com(=================================)
.entc(about,About HelpGen, ,general,270)
The .b(Help | About HelpGen) menu item provides information about
the current version of the HelpGen program.
.end
.com(=================================)
.com( language basics topic )
.com(=================================)
.entc(langbas,Language Basics, ,general,280)
HelpGen Macro Files consist of distinct blocks of text. These blocks
are marked by HelpGen .p(macro,macros). The first block is the
\'2estart/\'2eend/\'2eend_file block:.n
.n
.[
\li720
\'2estart(......).n
\tab Table of Contents stuff here.....n
\'2eend.n.n
\tab Rest of macro file goes here.....n.n
\'2eend_file.n
.]
.n
The rest of the macro file is broken up into \'2eent/\'2eend and
\'2epent/\'2eend blocks:.n
.n
.[
\li720
\'2estart(......).n
\tab Table of Contents stuff here.....n
\'2eend.n.n
\'2eent(.....).n
\tab Topic stuff here.....n
\'2eend.n.n
\'2eent(.....).n
\tab Topic stuff here.....n
\'2eend.n.n
\'2eent(.....).n
\tab Topic stuff here.....n
\'2eend.n.n
\'2epent(.....).n
\tab Popup stuff here.....n
\'2eend.n.n
\'2epent(.....).n
\tab Popup stuff here.....n
\'2eend.n.n
\'2eend_file.n
.]
.n
Note the use of white space to separate the various blocks. You may
also separate the blocks with remarks:.n
.n
.[
\li720
\'2erem(===== Beginning of topic 1 =====).n
\'2eent(.....).n
\tab Topic stuff here.....n
\'2eend.n
\'2erem(===== Beginning of topic 2 =====).n
\'2eent(.....).n
\tab Topic stuff here.....n
\'2eend.n
.]
.n
In order to display each of these blocks, you need to have jumps
(\'2ej or \'2ej1 for the \'2eent/\'2eend blocks and \'2ep or \'2ep1
for the \'2epent/\'2eend blocks) somewhere in your macro file.
Since the help file begins at the Table of Contents, there should
definitely be some jumps in that .p1(topic)..n
.n
All the rest of the HelpGen macros are basically window dressing for
the topic blocks. See the various macro commands for examples of
how to use them..n
.n
HelpGen generates an RTF file that specifies nine text fonts:.n.n
.in
font 0 - Arial (default for topic headers).n
font 1 - Times New Roman (default for normal text in a topic).n
font 2 - Courier (default for \'2e[ and \'2e] text).n
font 3 - MS Sans Serif.n
font 4 - Roman.n
font 5 - MS Serif.n
font 6 - Symbol.n
font 7 - Helv.n
font 8 - Arial MT.n
.un
Fonts 0, 1 and 8 are True Type fonts..n
.end
.com(=================================)
.com( macro commands TOC topic )
.com(=================================)
.entc(maccmd,Macro Language Commands, ,general,290)
.in
.bi(Topic Macros)
##.j(cmdstr,\'2estart)
##.j(cmdstrc,\'2estartc)
##.j(cmdent,\'2eent)
##.j(cmdentc,\'2eentc)
##.j(cmdpent,\'2epent)
##.j(cmdpentc,\'2epentc)
##.j(cmdend,\'2eend).n.n
.bi(Hypertext Navigation Macros)
##.j(cmdj,\'2ej)
##.j(cmdj1,\'2ej1)
##.j(cmdp,\'2ep)
##.j(cmdp1,\'2ep1)
##.j(cmdbj,\'2ebj)
##.j(cmdbp,\'2ebp)
##.j(cmdfj,\'2efj)
##.j(cmdbfj,\'2ebjf).n.n
.bi(Keyword Macros)
##.j(cmdtop,\'2etop).n.n
.bi(Graphics Display Macros)
##.j(cmdbmp,\'2ebmp)
##.j(cmdbmpl,\'2ebmpl)
##.j(cmdbmpr,\'2ebmpr).n.n
.bi(Box Macros)
##.j(cmdbox,\'2ebox)
##.j(cmdbend,\'2ebend).n.n
.bi(Documentation Macros)
##.j(cmdrem,\'2erem)
##.j(cmdcom,\'2ecom).n.n
.bi(Text Formatting Macros)
##.j(cmdin,\'2ein)
##.j(cmdun,\'2eun)
##.j(cmdpp,\'23\'23)
##.j(cmdbi,\'2ebi)
##.j(cmdbu,\'2ebu)
##.j(cmdiu,\'2eiu)
##.j(cmdpb,\'23b)
##.j(cmdpn,\'23n)
##.j(cmdb,\'2eb)
##.j(cmdi,\'2ei)
##.j(cmdob,\'2e[)
##.j(cmdcb,\'2e])
##.j(cmdn,\'2en)
##.j(cmds,\'2es)
##.j(cmdc,\'2ec).n.n
.bi(Help Macro Access Macros)
##.j(cmdmacro,\'2emacro)
##.j(cmdbmacro,\'2e\'62macro).n.n
.bi(Miscellaneous Macros)
##.j(cmdbf,\'2ebegin_file)
##.j(cmdef,\'2eend_file)
.un
.end
.end_file